HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, published by My Organization. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/costateixeira/kmehrms and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Logical Model: KMEHR MS

KMEHR MedSchema Data Model

Usage:

• This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
header		1..1	class	KMEHR Message header
id		0..1	string
standard		0..1	class
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
recipient		0..1	class
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
date		1..1	date
time		0..1	time
content		0..*	class	To Do
medicinalproduct		0..*	class	Description of the medicinal product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
magistraltext		1..1	ST	Recipe of the prescription
compound		0..0
formularyReference		0..0
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
content-text		0..*	class
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
content-category		1..*	class
cd		0..*	class
content-text		0..*	class
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
medicinalproduct		0..*	class	Description of the medicinal product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
magistraltext		1..1	ST	Recipe of the prescription
compound		0..0
formularyReference		0..0
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
cd		0..1	string
frequency		0..*	class	To Do
periodicity		0..*	class	To Do
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
text		0..*	string	To Do
low		0..0
high		0..0
unit		0..0
takes		0..0
regimen		0..*	class	To Do
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
cd		0..*	string
quantity		1..1	class	To Do
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
cd		0..*	string	To Do
route		0..*	class	The drug administration route
cd		0..*	unknown	To Do
instructionForOverDosing		0..0
instructionForReimbursement		0..0
isSubstitutionAllowed		0..0
feedback		0..0
local		0..0
batch		0..0
deliveryDate		0..0
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
header		1..1	class	KMEHR Message header
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
standard		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
recipient		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
content		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-text		0..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-category		1..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	class
content-text		0..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	string
frequency		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
periodicity		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..*	string	To Do
regimen		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string
quantity		1..1	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string	To Do
route		0..*	class	The drug administration route
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	To Do
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
header		1..1	class	KMEHR Message header
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
standard		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
recipient		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length: 1048576
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
content		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-text		0..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-category		1..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	class
content-text		0..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	string
frequency		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
periodicity		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..*	string	To Do
regimen		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
extension		0..*	Extension	Additional content defined by implementations
value		0..1	integer	Primitive value for integer
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string
quantity		1..1	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string	To Do
route		0..*	class	The drug administration route
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	To Do
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (86 nested mandatory elements)
Prohibited: 15 elements

Structures

This structure refers to these other structures:

• class (http://example.com/fhir/example/StructureDefinition/class)
• CD (http://example.com/fhir/example/StructureDefinition/CD)
• unknown (http://example.com/fhir/example/StructureDefinition/unknown)
• ST (http://example.com/fhir/example/StructureDefinition/ST)

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
header		1..1	class	KMEHR Message header
id		0..1	string
standard		0..1	class
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
recipient		0..1	class
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
date		1..1	date
time		0..1	time
content		0..*	class	To Do
medicinalproduct		0..*	class	Description of the medicinal product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
magistraltext		1..1	ST	Recipe of the prescription
compound		0..0
formularyReference		0..0
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
content-text		0..*	class
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
hcparty-hub		0..1	class	the identifier of the hub
id		1..1	string	the hub identifier Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
id		0..1	string	the org identifier - NIHDII number of the org Example null: 1990001916
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
id		1..1	string	the software identifier
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
content-category		1..*	class
cd		0..*	class
content-text		0..*	class
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
id		0..*	integer	a sequential unique item ID within the transaction, start=1
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
medicinalproduct		0..*	class	Description of the medicinal product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
magistraltext		1..1	ST	Recipe of the prescription
compound		0..0
formularyReference		0..0
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
cd		0..1	string
frequency		0..*	class	To Do
periodicity		0..*	class	To Do
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
text		0..*	string	To Do
low		0..0
high		0..0
unit		0..0
takes		0..0
regimen		0..*	class	To Do
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
cd		0..*	string
quantity		1..1	class	To Do
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
cd		0..*	string	To Do
route		0..*	class	The drug administration route
cd		0..*	unknown	To Do
instructionForOverDosing		0..0
instructionForReimbursement		0..0
isSubstitutionAllowed		0..0
feedback		0..0
local		0..0
batch		0..0
deliveryDate		0..0
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
header		1..1	class	KMEHR Message header
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
standard		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
recipient		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
content		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-text		0..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-category		1..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	class
content-text		0..*	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	string
frequency		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
periodicity		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..*	string	To Do
regimen		0..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string
quantity		1..1	class	To Do
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string	To Do
route		0..*	class	The drug administration route
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	To Do
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
KMEHRMS		0..*	Base	KMEHR MS
KMEHRMessage		1..1	class	KMEHR Message
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
header		1..1	class	KMEHR Message header
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
standard		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	CD	The version of the KMEHR standard used
date		0..1	date
time		0..1	time
sender		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
recipient		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
folder		1..1	class	The only data that matters
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	ID-KMEHR
patient		1..1	class	the patient
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-inss		0..1	string	the Belgian Social Security Number identifier
firstname		0..1	string	First name of the patient. If no first name exists, the element will be empty.
familyname		0..1	string	Family name of the patient
birthdate		0..1	date	Birth date of the patient (uses the basic data types for dates)
deathdate		0..1	date	this is not used
sex		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	Sex of the patient
address		0..1	class	Home, work, … address(es) of the patient.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code
zip		0..1	integer
city		0..1	string
street		0..1	string
housenumber		0..1	string
nationality		0..1	string	Nationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
extension		0..*	Extension	Additional content defined by implementations
value		0..1	string	Primitive value for string Max Length: 1048576
cd		1..1	code
usuallanguage		0..1	string	Usual language of the patient using the W3C language codes.
telecom		0..1	string	Fax, phone, … number(s) of the patient.
recorddatetime		0..1	unknown	Date of recording of the patient data.
text		0..1	string	Comment about the patient.
MSTransaction		1..1	class	The metadata for the message
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-others		0..*	integer	Local ID of the medication line
cd		1..1	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		1..1	integer	version of the medication scheme
MSETransaction-treatmentSuspension		0..*	class	The treatment suspension line(s)
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
item-medication		0..*	class	This describes the medication it is linked to, but has no further relevance
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	the end date (and time) of the suspension
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
content		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
lifecycle		1..1	string	todo
lnk		1..1	string	using a link to the transaction (in the current MedicationSchema) of the related medicine,
item-transactionreason		0..1	class	Extra information on the reason of suspention of the linked medication
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-text		0..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: Temporairement ne pas prendre en raison de l'interaction avec Y.
MSETransaction-medication		0..*	class	The medication lines
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-kmehr		1..1	integer	the KMEHR identifier for the medication line
id-other		0..*	string	Local ID of the medication line
cd		0..*	code
date		1..1	date	The date when the line was registered in the schema
time		1..1	date	The time when the line was registered in the schema
author		1..1	class	The author of the line in the schema
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hcparty-hub		0..1	class	the identifier of the hub
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the hub
hcparty-org		0..1	class	the identifier of the org
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
name		0..1	string	the name of the org
hcparty-individual		1..1	class	the identifier of the individual
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
id-riziv		0..1	string	the RIZIV individual identifier
id-inss		0..1	string	the Belgian Social Security Number identifier Example null: 69060733632
id-encryptionActor		0..1	integer	to be checked: usage & cardinality
cd		1..1	code	the type of the hcparty Example null: persphysician
cd-encryptionActor		0..1	class	to be checked: usage & cardinality
firstname		0..1	string	the first name of the individual
familyname		0..1	string	the last name of the individual Example null: Hendrix
address		0..*	class	Home, work, ... address(es) of the patient or healthcare party.
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	class
nis		0..1	code	explanation: https://nl.wikipedia.org/wiki/NIS-code Example null: 24062
telecom		0..*	string	Fax, phone, … number(s) of the healthcare party.
hcparty-application		0..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		1..1	code	the type of the hcparty
isComplete		1..1	boolean	is complete
isValidated		1..1	boolean	is validated
version		0..*	string	TO DO
item-medicationUse		0..1	class	Extra information on the usage of the medication within this transaction
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
content-category		1..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	class
content-text		0..*	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		1..*	string	cardinality to be checked Example null: pression artérielle
item-medication		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	describes the item category
beginMoment		1..1	class
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
endMoment		0..1	class	The end moment
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		1..1	date
time		0..1	time
duration		0..1	integer	The duration of the treatment
content		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
medicinalproduct		0..*	class	Description of the medicinal product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	CD-DRUG-CNK + Code (CNK)
substanceproduct		0..*	class	Description of the generic product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
intendedName		0..1	ST	Name of prescribed product
intendedCd		0..1	CD	Code of prescribed product (INN or CNK)
deliveredName		0..1	ST	Name of delivered product
deliveredCd		0..1	CD	Code of delivered product (CNK)
compoundprescription		0..*	class	Description of the compound product
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
magistraltext		1..1	ST	Recipe of the prescription
text		0..*	string	Mandatory if compoundprescription is used
temporality		0..*	class	The temporality
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..1	string
frequency		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
periodicity		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	S-VALUE=CD-PERIODICITY
posology		0..*	class	The po
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
text		0..*	string	To Do
regimen		0..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..*	date	date, mostly used icw periodicity=monthly or at a specifiec time of the day
weekday		0..*	integer	Day of the week, mostly used icw periodicity=weekly
extension		0..*	Extension	Additional content defined by implementations
value		0..1	integer	Primitive value for integer
cd		1..1	string	the day of the week Example null: monday
daynumber		0..*	integer	Daynumber, mostly used icw periodicity=weekly or daily
daytime		0..*	class	indication of the intake moment
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
time		1..1	date	The time when the line was registered in the schema
dayperiod		1..*	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string
quantity		1..1	class	To Do
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
decimal		0..*	integer	the amount, expressed in a number
unit		0..*	class	the prescribed administration unit where the decimal applies to
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	string	To Do
route		0..*	class	The drug administration route
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
cd		0..*	unknown	To Do
instructionforpatient		0..1	string	Usage instructions for the patient. Example null: A diminuer si possible
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element (86 nested mandatory elements)
Prohibited: 15 elements

Structures

This structure refers to these other structures:

• class (http://example.com/fhir/example/StructureDefinition/class)
• CD (http://example.com/fhir/example/StructureDefinition/CD)
• unknown (http://example.com/fhir/example/StructureDefinition/unknown)
• ST (http://example.com/fhir/example/StructureDefinition/ST)